home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / spitfire / sffam213.zip / SFFAM.DOC < prev    next >
Text File  |  1994-08-13  |  16KB  |  394 lines
  1.  
  2.                      SF-FAM v2.11
  3.               Spitfire File Area Manager
  4.                  from Fifth Dimension
  5.  
  6. This program is Copyright 1993-1994 by David Pontius.
  7. The shareware version of the program may be distributed freely,
  8. however the source code remains the property of the author.
  9. Users are given a 30-day trial period to evaluate this program.
  10. After the trial period is over, users must either register the 
  11. program or discontinue using it.
  12.  
  13. INTRODUCTION
  14. ============
  15. SF-FAM is a file manager for the Spitfire Bullitin Board.
  16. It fully supports file sharing.
  17. It fully supports Spitfire defined CD-ROM file areas, and file areas
  18.             not defined by Spitfire.
  19. REQUIRED: SF 3.5+, DOS 3.x or above
  20. Once registered, all updates are FREE!!!
  21. The registration validation is done by Brian Pirie's 
  22.     Registration Key System for C Programmers.
  23.  
  24. WHO TO CONTACT FOR TECHNICAL SUPPORT
  25. ======================================
  26. Freedom City BBS:   (602)747-5415 
  27.                     1200-14400 bps
  28.                     24hrs.
  29. CircuitNet:         602109
  30. Fido:               1:300/604
  31. CNFD:               169:6021/109 
  32. FREQ                Magic filename: SFFAM
  33.                     This will get you the latest version.
  34. Address:            Fifth Dimension
  35.                     P.O. Box 18956
  36.                     Tucson, Az 85731
  37.  
  38. Latest version:
  39.             Other sources:   Buffalo Creek's BBS (515)225-8496
  40.                                 
  41.                             
  42. REGISTRATION
  43. ============
  44. See SFFAM.REG
  45.  
  46.  
  47. INSTALLATION
  48. ============
  49. To install SF-FAM, you may put the required files in any directory.
  50. The required files are:
  51.     SFFAM.EXE - main executable
  52.     SFFAM.HLP - text help file
  53.     SFFAM.NDX - index help file
  54.  
  55.     COMMAND LINE PARAMETERS:
  56.     ------------------------
  57.     SFFAM /C : runs configure ( see setup below )
  58.     SFFAM /DIR= : Directory containing SFNODE.DAT/SFFAREA.DAT.
  59.                         This will override the SFNODE.DAT/SFFAREA.DAT 
  60.                     directory in SFFAM.DAT.
  61.                         Example: SFFAM /DIR=C:\SF2
  62.                             /C      Runs configuration.
  63.     /DIR=   Directory to SFNODE.DAT/SFFAREA.DAT
  64.     /BBS=   Filename of external file areas. Does not need
  65.             to be SFFAM.BBS.
  66.     /VA     Verify sizes in all areas. (CD-ROMS will be skipped if
  67.             disabled in the configuration)
  68.     /V#     Vefify sizes in area # only. Example. SFFAM /V3 will verify
  69.             this sizes in area 3 and update it if necessary.
  70.     /HA     Make headers for all areas.
  71.     /H#     Make header for area # only. Example. SFFAM /H2 will create
  72.             a header for area 2 only.
  73.     /SAA    Sort Ascending date, all areas.
  74.     /SFA    Sort Filename, all areas.
  75.     /SDA    Sort Descending date, all areas.
  76.     /SA#    Sort Ascending date, area #. Ex. SFFAM /SA3
  77.     /SF#    Sort Filename, area #. Ex. SFFAM /SF10
  78.     /SD#    Sort Descending date, area #. Ex. SFFAM /SD5
  79.  
  80.     In addition, you may run several paramaters at once.
  81.  
  82.     Example:
  83.     SFFAM /V5 /HA /DIR=C:\SUBSF /H1 /SFA
  84.  
  85.     This would first verify the sizes in area 5. The SF directory would
  86.     be the directory defined in SFFAM.DAT. It would then make headers
  87.     for all the file areas. It then switches to the C:\SUBSF directory,
  88.     then makes a header for area 1. It then Sorts all the areas in defined
  89.     in C:\SUBSF by filename.
  90.  
  91.     The first directory used will be the one defined in SFFAM.DAT, unless 
  92.     the first paramter is /DIR=.
  93.     A /DIR= is valid until changed by another /DIR=.
  94.  
  95.         All command line parameters are case insensitive.
  96.  
  97.     SETUP:
  98.     ------
  99.     To configure up SF-FAM, just type SFFAM. If the SFFAM.DAT file is
  100.     not found, one will be created.
  101.         
  102.     GENERAL CONFIGURATION:
  103.     ----------------------
  104.     Registration Code:
  105.         This will be sent to you after you register SF-FAM.
  106.     Direct video writes:
  107.         TRUE allows writes directly to video RAM,
  108.         FALSE will use the computer's video BIOS.
  109.             While TRUE should work in almost all cases, if you
  110.             experience video problems, you may want to set this
  111.             to FALSE.  This will most often occur when multi-tasking.
  112.     CDROM on Global Options:
  113.         If set to FALSE, CD-ROM areas will not be processed if a global
  114.         command is issued. i.e. Global Sort  
  115.     Swap to EMS/XMS when shelling to DOS:
  116.         TRUE will enable EMS/XMS swaps.
  117.         FALSE will force SF-FAM to swap to disk when shelling to DOS.
  118.     Lines of file_id.diz to use: 
  119.         Sets the number of lines SF-FAM will use when reading the file_id.diz
  120.         in a file. 0 will turn off this feature. Range is 0 to 99. ARJ, ZIP,
  121.         LZH, and .SDN files are supported.
  122.     Temp directory:
  123.         REQUIRED: 
  124.         This is the directory SF-FAM uses to swap to disk, and also to
  125.         put the FILE_ID.DIZ . This can be set to a RAM disk for best results.
  126.             ***Set this even if you have EMS/XMS swapping enabled. If there
  127.                         is not enough memory, SF-FAM will automatically switch to
  128.                         disk swapping.
  129.     Sort Preference:
  130.         This is used when adding and moving files only. SF-FAM will
  131.         add in this sort order. Files moved will be added to the new
  132.         area in this order. Options are:
  133.         Sort by filename
  134.         Sort by date, ascending( low to high )
  135.         Sort by date, descending( high to low )
  136.     Puts overlays in EMS/Extended memory:
  137.         This will put SF-FAM overlays in EMS or extended memory if available.
  138.         Setting this to true will increase speed.
  139.  
  140.     EXTERNAL PROGRAMS:
  141.     ------------------
  142.     You can configure up to 10 external programs. 
  143.         For a shell to DOS simply use COMSPEC. This will be converted
  144.         to the COMSPEC environment variable.
  145.         
  146.         You may use +f as a command line parameter. It will be converted
  147.         to the path/filename of the the current highlighted file.
  148.         ex. 'zipmgr +f' is converted to 'zipmgr C:\NEWUP\ALLFILES.ZIP
  149.  
  150.         A colon will cause SF-FAM to change to the download drive and
  151.         path of the current file area. The program will most likely need
  152.         to be in your path.
  153.         ex. ':SHEZ'
  154.  
  155.         You may run .exe, .com, or .bat files.
  156.  
  157.         The external program information is saved in SFFAM.EXT.
  158.  
  159.     COLORS:
  160.     -------
  161.     You can easily change the default colors used in SF-FAM. The possible
  162.     background and foreground colors are shown on the top half of the
  163.     screen.
  164.     The toggles are shown in the bottom half. To change a colors, simply
  165.     press the corresponding letter, and it will toggle through all 
  166.     available colors. 
  167.  
  168.     Input Fields: Any window that you need to type in something.
  169.     Stats Field: The field at the top showing number of files, etc.
  170.     SFFILES-Normal: The filename and description, when it is not highlighted.
  171.     SFFILES-Hilite: The filename and description, when it is highlighted.
  172.     Error windows: Any window which displays some type of error.
  173.     Status windows: Any window which is just there to let you know the
  174.         program hasn't stopped.
  175.     Help windows: The online help,accessible with F1.
  176.     General hilite: The color used to highlight items, such as the A,B,C,
  177.         in the configuration.
  178.  
  179. That's all there is to it.
  180. To run SF-FAM, simply type SFFAM.
  181.  
  182. NOTE: SFFAM.DAT, SFFAM.HLP, and SFFAM.NDX must be in the current directory.
  183.     
  184. CD-ROMS
  185. =======
  186. SF-FAM will check in the SFFAREA.DAT for any CD-ROM areas. It will then
  187. check the SFNODE.DAT for the Spitfire Display directory. 
  188. The file list for the CD-ROM area is expected to be in the display 
  189. directory with the filename of SFFILES.x, where x is the file area.
  190. For further information, please see your Spitfire manual.
  191.  
  192. FA?.TXT
  193. =======
  194. SF 3.5 supports multiple download paths using a file called FA?.TXT, located
  195. in the Spitfire home directory. SF-FAM supports this file in all operations.
  196.  
  197. EXTERNAL AREAS
  198. ===============
  199. SF-FAM will check for a file called SFFAM.BBS. This file defines file
  200. areas not defined in Spitfire. This is primarily for use with CDROM doors,
  201. however, it may be used in any area.
  202.  
  203. Each external file area is defined with 3 lines.
  204. SFFAM.BBS must be created by you if you wish to use it.
  205.  
  206.     Line 1 is the File Description. It must be less than 40 characters.
  207.     Line 2 is the Download Path. It must be less than 60 characters.
  208.     Line 3 is the Path and Filename of the Filelist. It must be less than
  209.         74 characters. The filelist MUST be in SFFILES.BBS format.
  210.  
  211.     example:
  212.  
  213.     The Super CD Games Area
  214.     f:\files\games
  215.     d:\rom\list1.bbs
  216.     LotsaFiles CD-ROM Utilities
  217.     g:\files\util
  218.     d:\rom\lotsutil.5
  219.  
  220. You may also give this file a different name and load it only with a 
  221. command line parameter. 
  222.     Example: Rename SFFAM.BBS to CDROMS.BBS.
  223.                 It will only be loaded you you type
  224.                 SFFAM /BBS=CDROMS.BBS
  225.  
  226. FILE AREA PICK
  227. ==============
  228. This first screen you will see is the list of file areas on the BBS.
  229. Your options are:
  230.  
  231.     <ENTER> - goto this file area
  232.     <ESC>   - exit SF-FAM
  233.     <Alt-H>    - On-line help
  234.     V       - Verify the sizes of all files in all areas.  The file size
  235.                     in SFFILES.BBS will be checked against the file size of the
  236.                     actual file.  If it is different, the file size in
  237.                     SFFILES.BBS will be updated and saved.  The location of the 
  238.                     commas is also checked, and updated if necessary.
  239.     S       - Sort. This will allow you to sort all file areas by either
  240.                     Filename or Ascending Date( low to high ) or Descending date
  241.                     ( high to low ).
  242.     H       - Create headers for the SFFILES.BBS in all areas.
  243.     T       - Search for selected Text in all file areas.
  244.     B       - Change location of the SFFAREA/SFFNODE.DAT. Great for 
  245.                     sub-boards.
  246.     C       - Run Configuration.
  247.     E       - Run File Area Editor.
  248.     <UpArr> - Moves cursor up one.
  249.     <DnArr> - Moves cursor down one.
  250.     <PgUp>  - Moves cursor up one page.
  251.     <PgDn>  - Moves cursor down one page.
  252.     <Home>  - Moves to top of list.
  253.     <End>   - Moves to bottom of list.
  254.  
  255. SFFILES.BBS DISPLAY
  256. ===================
  257. This will display your files in the SFFILES.BBS.  It supports multi-line
  258. descriptions, up to five lines. All references to SFFILES.BBS include
  259. the SFFILES.x for Spitfire defined CD-ROM areas and the filelist defined
  260. in SFFAM.BBS.
  261. If the SFFILES.BBS does not exist, you will be asked if you want to
  262. create it.
  263.  
  264. Your options are:
  265.  
  266.     <space> - tags/untags file.  <ENTER> will do the same.
  267.     Alt-T   - tags all files in area.
  268.     Alt-U   - untags all files in area.
  269.     <ESC>   - exit file area.  If changes have been made, you will be asked
  270.                     if you want to save them.
  271.     <Alt-H>    - On-line help.
  272.     A       - checks download directory for any files not in SFFILES.BBS.
  273.                     If found you will be asked if you want to add them to 
  274.                     SFFILES.BBS.  If you select yes, the edit screen will appear.
  275.                     After you are done editing, the file will be added to the
  276.                     end of the list. <SEE ALSO: E - edit file description>
  277.                 You may delete the file by pressing 'd' at the add prompt.
  278.                 NOTE: SFFILES.BBS, SFFILES.BAK and SFFILES.OLD are skipped.
  279.     C       - will copy the file under the cursor to any drive/directory.
  280.                     Do not use this to move a file to another file area. That 
  281.                     should be done using the Move command.
  282.     Alt-C   - will copy all tagged files to any drive/directory.
  283.     D       - will delete the file under the cursor from both SFFILES.BBS
  284.                     and from the disk.  You will be asked to confirm the delete.
  285.     Alt-D   - will  delete all tagged files from both SFFILES.BBS and from
  286.                     the disk.  You will be asked to confirm each delete.
  287.     E       - Edit file description.  This will allow you to change the
  288.                     File name, file size, file date, and file description of the
  289.                     file under the cursor.
  290.                     
  291.                     EDIT KEYS
  292.                     ---------
  293.                     CTRL-L-ARROW: Go to previous word
  294.                     CTRL-R-ARROW: Go to next word
  295.                     HOME: Beginning of field
  296.                     END: End of field
  297.                     DOWN/UP ARROW: Next/Previous field
  298.                     R-ARROW/L-ARROW: Move cursor right/left one position
  299.                     INS: Insert space at current cursor position
  300.                     DEL: Delete character at current cursor position
  301.                     ESC: Exits, and if anything has changed, prompts you to save
  302.                     changes.
  303.     F       - Use the file_id.diz in this file for the description. The
  304.                     editing window will be brought up.
  305.     Alt-F   - Use the file_id.diz in the tagged files for the description.
  306.     H       - Create a header for this area.
  307.     K       - mark this file with current or actual file date.
  308.     Alt-K   - mark all tagged files with current or actual file date.
  309.     M       - move file under cursor to new file area.  The file on disk
  310.                     and in the SFFILES.BBS will be moved to the new file area.
  311.                     The file will be added in sort order to the new SFFILES.BBS.
  312.                     If the new SFFILES.BBS does not exist, you will be asked if
  313.                     you want to create it.
  314.     Alt-M   - move tagged files to new file area.  The files on disk and
  315.                     in the SFFILES.BBS will be moved to the new file area and
  316.                     added in sort order to the new SFFILES.BBS. If the new 
  317.                     SFFILES.BBS does not exist, you will be asked if you want to
  318.                     create it.
  319.     N       - rename the file. This will rename both the file in SFFILES.BBS
  320.                     and the file on disk.
  321.     O       - move files offline. This will move the file to the selected
  322.                     drive/directory. OFFLINE will be marked( right justified ) in
  323.                     the file size field.
  324.     Alt-O   - move tagged files offline.  This will moved the tagged files
  325.                     to the selected drive/directory. OFFLINE will be marked
  326.                     ( right justified ) in the file size field.
  327.     R       - remove file from SFFILES.BBS.  This will NOT delete the file 
  328.                     from disk.  This is handy if you want to have a file
  329.                     for download, but not let everyone know about it.  You will
  330.                     be asked to confirm the removal.
  331.     Alt-R   - remove tagged files.  This will NOT delete the files from 
  332.                     disk.  You will be asked to confirm each removal.
  333.     S       - sort files.  This will sort the files in the current file
  334.                     area by File name or File date( asending or desending).
  335.     T       - text search.  This will search all files and descriptions
  336.                     in the area for a text string.  Case does not matter.
  337.     V       - verify file sizes and file exists.  If the file size of the
  338.                     actual file is different that the size in SFFILES.BBS, the
  339.                     size in SFFILES.BBS will be automatically updated.  If a file
  340.                     is in SFFILES.BBS, but not on disk, you will be asked if you
  341.                     want to remove the file from SFFILES.BBS.  The prompt will
  342.                     display the filename, file size, file date, and first line
  343.                     of the description.  If a file is OFFLINE, press 'O' and the 
  344.                     file will be marked offline.
  345.     X       - Xtra Options. This will switch between the two option screens.
  346.                     All options are available no matter which screen is showing.
  347.     Ctrl-D  - run DOS program. This will bring up a menu of up to 10 
  348.                     external program to run. For more information, see the 
  349.                     configuration information above. SF-FAM swaps almost
  350.                     completely out of memory on this option.
  351.     F1-F10  - This immediately run one of the DOS programs above.
  352.                     Alt-F1 is the first program, Alt-F2 is the second, etc.
  353.     Alt F1-
  354.     Alt F10 - Run external programs on tagged files.
  355.     Ctrl-S  - save SFFILES.BBS. This does not exit the file area.
  356.  
  357. -----------
  358. NOTES:
  359.     Anytime changes are made to the file area, you will be asked if you 
  360.     want to save SFFILES.BBS before exiting.  If you made a big mistake,
  361.     don't worry about it.
  362.  
  363.     There are some exceptions, however:
  364.         
  365.         If you move a file, the file on disk is moved immediately, and the
  366.         SFFILES.BBS in the new file area is updated immediately.  The 
  367.         current SFFILES.BBS is not updated until you use CTRL-S, or exit
  368.         the area.
  369.  
  370.         If you delete a file, the file on disk is deleted immediately, but
  371.         again, the SFFILES.BBS will not be updated until you save it.
  372.         If you rename a file, it will be renamed immediately on disk.
  373.  
  374. FILE AREA EDITOR
  375. ================
  376. This editor is almost an exact copy of the editor in Spitfire. 
  377. The only difference is the BBS directory can be changed. Great for
  378. sub-boards.
  379.  
  380.     For details, please see the section "CONFIGURING FILE AREA RECORDS"
  381.     in your Spitfire manual.
  382.  
  383. MEMORY NOTES
  384. ============
  385. When shelling to DOS, SF-FAM uses Ralf Brown's SPAWNO utility to swap almost
  386. completely out of memory.
  387.  
  388. COPYRIGHT INFORMATION
  389. =====================
  390. Spitfire is Copyright Buffalo Creek Software, 1987-1993
  391. SPAWNO is Copyright Ralf Brown, 1992
  392. Registration Key System for C Programmers is Copyright Brian Pirie, 1992
  393. SFFAM is Copyright David Pontius 1993-1994
  394.